'\" te
.\" Copyright (c) 2005, Sun Microsystems, Inc. All Rights Reserved.
.\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License").  You may not use this file except in compliance with the License.
.\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.  See the License for the specific language governing permissions and limitations under the License.
.\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE.  If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
.TH DDI_INTR_ENABLE 9F "Apr 22, 2005"
.SH NAME
ddi_intr_enable, ddi_intr_block_enable, ddi_intr_disable,
ddi_intr_block_disable \- enable or disable a given interrupt or range of
interrupts
.SH SYNOPSIS
.nf
#include <sys/types.h>
#include <sys/conf.h>
#include <sys/ddi.h>
#include <sys/sunddi.h>



\fBint\fR \fBddi_intr_enable\fR(\fBddi_intr_handle_t\fR \fIh\fR);
.fi

.LP
.nf
\fBint\fR \fBddi_intr_block_enable\fR(\fBddi_intr_handle_t *\fR\fIh_array\fR, \fBint\fR \fIcount\fR);
.fi

.LP
.nf
\fBint\fR \fBddi_intr_disable\fR(\fBddi_intr_handle_t\fR \fIh\fR);
.fi

.LP
.nf
\fBint\fR \fBddi_intr_block_disable\fR(\fBddi_intr_handle_t *\fR\fIh_array\fR, \fBint\fR \fIcount\fR);
.fi

.SH INTERFACE LEVEL
illumos DDI specific (illumos DDI).
.SH PARAMETERS
\fBddi_intr_enable()\fR
.sp
.ne 2
.na
\fB\fIh\fR\fR
.ad
.RS 5n
DDI interrupt handle
.RE

.sp
.LP
\fBddi_intr_block_enable()\fR
.sp
.ne 2
.na
\fB\fIh_array\fR\fR
.ad
.RS 11n
Pointer to an array of DDI interrupt handles
.RE

.sp
.ne 2
.na
\fB\fIcount\fR\fR
.ad
.RS 11n
Number of interrupts
.RE

.sp
.LP
\fBddi_intr_disable()\fR
.sp
.ne 2
.na
\fB\fIh\fR\fR
.ad
.RS 5n
DDI interrupt handle
.RE

.sp
.LP
\fBddi_intr_block_disable()\fR
.sp
.ne 2
.na
\fB\fIh_array\fR\fR
.ad
.RS 11n
Pointer to an array of DDI interrupt handles
.RE

.sp
.ne 2
.na
\fB\fIcount\fR\fR
.ad
.RS 11n
Number of interrupts
.RE

.SH DESCRIPTION
The \fBddi_intr_enable()\fR function enables the interrupt given by the
interrupt handle \fIh\fR.
.sp
.LP
The \fBddi_intr_block_enable()\fR function enables a range of interrupts given
by the \fIcount\fR and \fIh_array\fR arguments, where \fIcount\fR must be at
least \fB1\fR and \fIh_array\fR is pointer to a count-sized array of interrupt
handles.
.sp
.LP
The \fBddi_intr_block_enable()\fR function can be used only if the device or
host bridge supports the block enable/disable feature. The
\fBddi_intr_get_cap()\fR function returns the \fBRO\fR flag
\fBDDI_INTR_FLAG_BLOCK\fR if the device or host bridge supports the interrupt
block enable/disable feature for the given interrupt type. The
\fBddi_intr_block_enable()\fR function is useful for enabling MSI interrupts
when the optional per-vector masking capability is not supported.
.sp
.LP
The \fBddi_intr_enable()\fR or \fBddi_intr_block_enable()\fR functions must be
called after the required interrupt resources are allocated with
\fBddi_intr_alloc()\fR, the interrupt handlers are added through
\fBddi_intr_add_handler()\fR, and the required locks are initialized by
\fBmutex\fR(9F) or \fBrwlock\fR(9F).
.sp
.LP
Once enabled by either of the enable calls, the interrupt can be taken and
passed to the driver's interrupt service routine. Enabling an interrupt implies
clearing any system or device mask bits associated with the interrupt.
.sp
.LP
The \fBddi_intr_disable()\fR function disables the interrupt given by the
interrupt handle \fIh\fR.
.sp
.LP
The \fBddi_intr_block_disable()\fR function disables a range of interrupts
given by the \fIcount\fR and \fIh_array\fR arguments, where \fIcount\fR must be
at least \fB1\fR and \fIh_array\fR is pointer to a count-sized array of
interrupt handles.
.sp
.LP
The \fBddi_intr_block_disable()\fR function can be used only if the device or
host bridge supports the block enable/disable feature. The
\fBddi_intr_get_cap()\fR function returns the \fBRO\fR flag
\fBDDI_INTR_FLAG_BLOCK\fR if the device or host bridge supports the interrupt
block enable/disable feature for the given interrupt type. The
\fBddi_intr_block_disable()\fR function is useful for disabling MSI interrupts
when the optional per-vector masking capability is not supported.
.sp
.LP
The \fBddi_intr_disable()\fR or \fBddi_intr_block_disable()\fR functions must
be called before removing the interrupt handler and freeing the corresponding
interrupt with \fBddi_intr_remove_handler()\fR and \fBddi_intr_free()\fR,
respectively. The \fBddi_intr_block_disable()\fR function should be called if
the \fBddi_intr_block_enable()\fR function was used to enable the interrupts.
.SH RETURN VALUES
The \fBddi_intr_enable()\fR, \fBddi_intr_block_enable()\fR,
\fBddi_intr_disable()\fR, and \fBddi_intr_block_disable()\fR functions return:
.sp
.ne 2
.na
\fB\fBDDI_SUCCESS\fR\fR
.ad
.RS 15n
On success.
.RE

.sp
.ne 2
.na
\fB\fBDDI_EINVAL\fR\fR
.ad
.RS 15n
On encountering invalid input parameters.
.RE

.sp
.ne 2
.na
\fB\fBDDI_FAILURE\fR\fR
.ad
.RS 15n
On any implementation specific failure.
.RE

.SH CONTEXT
The \fBddi_intr_enable()\fR, \fBddi_intr_block_enable()\fR,
\fBddi_intr_disable()\fR, and \fBddi_intr_block_disable()\fR functions can be
called from kernel non-interrupt context.
.SH ATTRIBUTES
See \fBattributes\fR(7) for descriptions of the following attributes:
.sp

.sp
.TS
box;
c | c
l | l .
ATTRIBUTE TYPE	ATTRIBUTE VALUE
_
Interface Stability	Committed
.TE

.SH SEE ALSO
.BR attributes (7),
.BR ddi_intr_add_handler (9F),
.BR ddi_intr_alloc (9F),
.BR ddi_intr_dup_handler (9F),
.BR ddi_intr_free (9F),
.BR ddi_intr_get_cap (9F),
.BR ddi_intr_remove_handler (9F),
.BR mutex (9F),
.BR rwlock (9F)
.sp
.LP
\fIWriting Device Drivers\fR
.SH NOTES
Consumers of these interfaces should verify that the return value is not equal
to \fBDDI_SUCCESS\fR. Incomplete checking for failure codes could result in
inconsistent behavior among platforms.
.sp
.LP
If a device driver that uses \fBMSI\fR and \fBMSI-X\fR interrupts resets the
device, the device might reset its configuration space modifications. Such a
reset could cause a device driver to lose any \fBMSI\fR and \fBMSI-X\fR
interrupt usage settings that have been applied.
